Show torrent fields: creation_date, created_by, encoding #297

mario-nt · 2023-10-10T13:09:56Z

Resolves #278.

mario-nt · 2023-11-16T00:04:32Z

@josecelano Rebased and CI OK

josecelano · 2023-11-16T12:56:18Z

components/torrent/TorrentCreationDateTab.vue

+  }
+});
+
+// Takes the date in milliseconds/Epoch Time and converts it to human readable format


Hi @mario-nt,

I would move the comment to the function. If you think the name is not enough, you could change the name to epochTimeToHumanReadableUTC or timestampToHumanReadableUTC

Timestamp is in seconds (props.torrent.creation_date), not milliseconds. The Date constructor accepts milliseconds (new Date(date * 1000);). We are passing seconds to the function.

josecelano · 2023-11-16T12:58:41Z

src/helpers/DateConverter.ts

+export function epochToUtc (date: number) {
+  const convertedDate = new Date(date * 1000);
+  return convertedDate.toDateString();
+}


Hi @mario-nt since we are using TypeScript maybe we can introduce a new Timestamp type to make it explicit what the function needs.

I was using snake_case for JS functions and I guess also for filenames because they all start with a lowercase:

sanitizer.ts

slug.ts

It would be good to add a unit test for the function but it's a pain to add unit tests with Nuxt.

Hi @mario-nt since we are using TypeScript maybe we can introduce a new Timestamp type to make it explicit what the function needs.

Maybe something like:

type Timestamp = number; export function epochToUtc (timestamp: Timestamp) { new Date(timestamp.toMilliseconds()).toDateString(); }

But you can even use a field and check that the number is an integer.

josecelano · 2023-11-16T13:02:44Z

This is how the detail page looks with the new fields:

If the torrent creation date field is present in the torrent file, it is now shown as a UTC date in a human readable format. If there is no creation date, a no creation date provided message is displayed. And if there is an error parsing the creation date or if it is a no valid date, an invalid date text is shown.

Error checks added to the function that converts the torrent creation date from seconds to UTC human readable format. Refactor to the function logic's code has been applied.

If the torrent creation date field is present in the torrent file, it is now shown as a UTC date in a human readable format. If there is no creation date, a no creation date provided message is displayed. And if there is an error parsing the creation date or if it is a no valid date, an invalid date text is shown.

Error checks added to the function that converts the torrent creation date from seconds to UTC human readable format. Refactor to the function logic's code has been applied.

Date converter helper function now throws errors if the timestamp passed as argument is not an integer and if the Date() constructor returns an invalid date.

If the torrent creation date field is present in the torrent file, it is now shown as a UTC date in a human readable format. If there is no creation date, a no creation date provided message is displayed. And if there is an error parsing the creation date or if it is a no valid date, an invalid date text is shown.

Error checks added to the function that converts the torrent creation date from seconds to UTC human readable format. Refactor to the function logic's code has been applied.

Date converter helper function now throws errors if the timestamp passed as argument is not an integer and if the Date() constructor returns an invalid date.

mario-nt · 2023-11-29T19:49:40Z

@josecelano Ready for review.

mario-nt · 2023-12-03T00:20:25Z

@josecelano Ready for review.

josecelano · 2023-11-30T16:52:06Z

components/torrent/TorrentCreationDateTab.vue

+    <template v-if="!collapsed">
+      <div class="flex flex-col w-full h-full p-6 grow bg-base-100 rounded-2xl">
+        <template v-if="torrent.creation_date">
+          {{ unixTimeToHumanReadableUTC(torrent.creation_date) }}


Hi @mario-nt maybe inside the components we could use a wrapper helper with the name formatDateFromTimestamp.

josecelano · 2023-12-04T10:34:23Z

src/helpers/DateConverter.ts

+class InvalidDateError extends Error {}
+class WrongTimestamp extends Error {}
+
+// Takes the date in seconds from Epoch time and converts it to human readable format.


Hi @mario-nt I think we should use a format for comments like https://tsdoc.org/ but we can enforce that after installing MegaLinter.

josecelano · 2023-12-04T10:44:47Z

src/helpers/DateConverter.ts

+  try {
+    milliseconds = creationDate * 1000;
+  } catch (error) {
+    return new WrongTimestamp(`Could not convert ${creationDate} to milliseconds`);


Hi @mario-nt I think this line is never reached. If I'm not wrong miliseconds would be Infinity but ti will not throw an exception.

// Online Javascript Editor for free // Write, Edit and Run your Javascript code using JS Online Compiler let seconds = Number.MAX_VALUE; let miliseconds = seconds * 1000; console.log("test1: ", miliseconds); // Infinity try { milliseconds = seconds * 1000; } catch (error) { console.log("error", error); } console.log("test2: ", miliseconds); // Infinity

josecelano · 2023-12-04T10:47:14Z

src/helpers/DateConverter.ts

+  } catch (error) {
+    return new InvalidDateError(`Could not create a new date from ${milliseconds}`);
+  }
+  return !isNaN(convertedDate.valueOf()) ? convertedDate.toDateString() : new InvalidDateError(`Could not create a valid date from ${milliseconds}`);


Hi @mario-nt In general I prefer positive conditional:

return isNaN(convertedDate.valueOf()) ? new InvalidDateError( `Could not create a valid date from ${milliseconds}` ) : convertedDate.toDateString();

See https://softwareengineering.stackexchange.com/a/350474/430081

josecelano · 2023-12-04T10:52:56Z

src/helpers/DateConverter.ts

+  try {
+    convertedDate = new Date(milliseconds);
+  } catch (error) {
+    return new InvalidDateError(`Could not create a new date from ${milliseconds}`);
+  }


Hi @mario-nt I think the <Date function does not thorw any exception:

let seconds = Number.MAX_VALUE; let miliseconds = seconds * 1000; console.log("test1: ", miliseconds); // Infinity try { milliseconds = seconds * 1000; } catch (error) { console.log("overflow error", error); } console.log("test2: ", miliseconds); // Infinity try { convertedDate = new Date(seconds * 1000); } catch (error) { console.log("Date error", error); } console.log("test3: ", convertedDate); // Infinity

josecelano · 2023-12-04T11:13:54Z

src/helpers/DateConverter.ts

Some tests I did:

let seconds = Number.MAX_VALUE; let miliseconds = seconds * 1000; console.log("test1: ", miliseconds); // Infinity try { milliseconds = seconds * 1000; } catch (error) { console.log("overflow error", error); } console.log("test2: ", miliseconds); // Infinity try { convertedDate = new Date(seconds * 1000); } catch (error) { console.log("Date error", error); } console.log("test3: ", convertedDate); // Invalid Date convertedDate = new Date(1701688171 * 1000); console.log("test4: ", convertedDate); console.log("test5: ", convertedDate.toISOString()); console.log("test6: ", convertedDate.toUTCString());

Hi @mario-nt I've just created another example.

Why do you want to differentiate between an invalid timestamp in the database and a timestamp greater than the maximum Date? Now we are showing the value causing the error so we can find out later what happened.

mario-nt · 2023-12-21T21:10:26Z

@josecelano Changes applied.

josecelano · 2023-12-22T07:18:57Z

@josecelano Changes applied.

Hi @mario-nt it looks good but it needs to be rebased.

…ding Torrent details page now displays the creation date, created by and encoding fields.

If the torrent creation date field is present in the torrent file, it is now shown as a UTC date in a human readable format. If there is no creation date, a no creation date provided message is displayed. And if there is an error parsing the creation date or if it is a no valid date, an invalid date text is shown.

Error checks added to the function that converts the torrent creation date from seconds to UTC human readable format. Refactor to the function logic's code has been applied.

Date converter helper function now throws errors if the timestamp passed as argument is not an integer and if the Date() constructor returns an invalid date.

mario-nt · 2023-12-23T01:14:35Z

@josecelano Rebased.

josecelano · 2023-12-26T10:12:08Z

ACK 4281526

mario-nt force-pushed the #278-show-torrent-fields-creation_date-created-by-encoding branch 2 times, most recently from f5efbd9 to fe4e157 Compare October 25, 2023 12:56

josecelano added the Needs Rebase Base Branch has Incompatibilities label Oct 27, 2023

mario-nt force-pushed the #278-show-torrent-fields-creation_date-created-by-encoding branch from fe4e157 to 81fa3bb Compare November 7, 2023 16:21

mario-nt force-pushed the #278-show-torrent-fields-creation_date-created-by-encoding branch from 81fa3bb to d38abfc Compare November 15, 2023 23:57

mario-nt marked this pull request as ready for review November 16, 2023 00:04

josecelano requested changes Nov 16, 2023

View reviewed changes

mario-nt marked this pull request as draft November 20, 2023 12:51

mario-nt force-pushed the #278-show-torrent-fields-creation_date-created-by-encoding branch 7 times, most recently from 003c80d to f4b5ca6 Compare November 27, 2023 10:49

mario-nt force-pushed the #278-show-torrent-fields-creation_date-created-by-encoding branch from f4b5ca6 to ad0c609 Compare November 27, 2023 15:20

mario-nt force-pushed the #278-show-torrent-fields-creation_date-created-by-encoding branch from ad0c609 to 89f3f0c Compare November 27, 2023 15:39

mario-nt assigned mario-nt and unassigned mario-nt Nov 29, 2023

mario-nt force-pushed the #278-show-torrent-fields-creation_date-created-by-encoding branch from 1443c0e to f6ff259 Compare November 29, 2023 19:41

mario-nt marked this pull request as ready for review November 29, 2023 19:48

mario-nt added a commit to mario-nt/torrust-index-gui that referenced this pull request Dec 3, 2023

refactor: [torrust#297] refactored error control

8e47ec0

josecelano requested changes Dec 4, 2023

View reviewed changes

mario-nt added a commit to mario-nt/torrust-index-gui that referenced this pull request Dec 20, 2023

refactor: [torrust#297] code cleanup

85a927c

josecelano approved these changes Dec 22, 2023

View reviewed changes

MMelchor and others added 6 commits December 23, 2023 01:42

feat: [torrust#278] show torrent fields creation date created by enco…

56af742

…ding Torrent details page now displays the creation date, created by and encoding fields.

refactor: [torrust#297] added error checks

5bad420

Error checks added to the function that converts the torrent creation date from seconds to UTC human readable format. Refactor to the function logic's code has been applied.

refactor: [torrust#297] new error checks and refactoring

e4772ae

Date converter helper function now throws errors if the timestamp passed as argument is not an integer and if the Date() constructor returns an invalid date.

refactor: [torrust#297] refactored error control

489da9d

refactor: [torrust#297] code cleanup

4281526

mario-nt force-pushed the #278-show-torrent-fields-creation_date-created-by-encoding branch from 85a927c to 4281526 Compare December 23, 2023 01:08

josecelano merged commit b61905b into torrust:develop Dec 26, 2023

Show torrent fields: creation_date, created_by, encoding #297

Show torrent fields: creation_date, created_by, encoding #297

Uh oh!

Conversation

mario-nt commented Oct 10, 2023

Uh oh!

mario-nt commented Nov 16, 2023

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

josecelano commented Nov 16, 2023

Uh oh!

mario-nt commented Nov 29, 2023

Uh oh!

mario-nt commented Dec 3, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mario-nt commented Dec 21, 2023

Uh oh!

josecelano commented Dec 22, 2023

Uh oh!

mario-nt commented Dec 23, 2023

Uh oh!

josecelano commented Dec 26, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

mario-nt commented Dec 3, 2023 •

edited

Loading